3 * Options for the PHP parser
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use Wikimedia\ScopedCallback
;
26 * @brief Set options of the Parser
28 * How to add an option in core:
29 * 1. Add it to one of the arrays in ParserOptions::setDefaults()
30 * 2. If necessary, add an entry to ParserOptions::$inCacheKey
31 * 3. Add a getter and setter in the section for that.
33 * How to add an option in an extension:
34 * 1. Use the 'ParserOptionsRegister' hook to register it.
35 * 2. Where necessary, use $popt->getOption() and $popt->setOption()
43 * Default values for all options that are relevant for caching.
44 * @see self::getDefaults()
47 private static $defaults = null;
53 private static $lazyOptions = [
54 'dateformat' => [ __CLASS__
, 'initDateFormat' ],
58 * Specify options that are included in the cache key
61 private static $inCacheKey = [
63 'numberheadings' => true,
65 'stubthreshold' => true,
71 * Current values for all options that are relevant for caching.
77 * Timestamp used for {{CURRENTDAY}} etc.
79 * @note Caching based on parse time is handled externally
86 * @todo Track this for caching somehow without fragmenting the cache insanely
91 * Function to be called when an option is accessed.
93 * @note Used for collecting used options, does not affect caching
95 private $onAccessCallback = null;
98 * If the page being parsed is a redirect, this should hold the redirect
101 * @todo Track this for caching somehow
103 private $redirectTarget = null;
106 * Appended to the options hash
108 private $mExtraKey = '';
111 * @name Option accessors
116 * Fetch an option, generically
118 * @param string $name Option name
121 public function getOption( $name ) {
122 if ( !array_key_exists( $name, $this->options
) ) {
123 throw new InvalidArgumentException( "Unknown parser option $name" );
126 if ( isset( self
::$lazyOptions[$name] ) && $this->options
[$name] === null ) {
127 $this->options
[$name] = call_user_func( self
::$lazyOptions[$name], $this, $name );
129 if ( !empty( self
::$inCacheKey[$name] ) ) {
130 $this->optionUsed( $name );
132 return $this->options
[$name];
136 * Set an option, generically
138 * @param string $name Option name
139 * @param mixed $value New value. Passing null will set null, unlike many
140 * of the existing accessors which ignore null for historical reasons.
141 * @return mixed Old value
143 public function setOption( $name, $value ) {
144 if ( !array_key_exists( $name, $this->options
) ) {
145 throw new InvalidArgumentException( "Unknown parser option $name" );
147 $old = $this->options
[$name];
148 $this->options
[$name] = $value;
153 * Legacy implementation
154 * @since 1.30 For implementing legacy setters only. Don't use this in new code.
155 * @deprecated since 1.30
156 * @param string $name Option name
157 * @param mixed $value New value. Passing null does not set the value.
158 * @return mixed Old value
160 protected function setOptionLegacy( $name, $value ) {
161 if ( !array_key_exists( $name, $this->options
) ) {
162 throw new InvalidArgumentException( "Unknown parser option $name" );
164 return wfSetVar( $this->options
[$name], $value );
168 * Whether to extract interlanguage links
170 * When true, interlanguage links will be returned by
171 * ParserOutput::getLanguageLinks() instead of generating link HTML.
175 public function getInterwikiMagic() {
176 return $this->getOption( 'interwikiMagic' );
180 * Specify whether to extract interlanguage links
181 * @param bool|null $x New value (null is no change)
182 * @return bool Old value
184 public function setInterwikiMagic( $x ) {
185 return $this->setOptionLegacy( 'interwikiMagic', $x );
189 * Allow all external images inline?
192 public function getAllowExternalImages() {
193 return $this->getOption( 'allowExternalImages' );
197 * Allow all external images inline?
198 * @param bool|null $x New value (null is no change)
199 * @return bool Old value
201 public function setAllowExternalImages( $x ) {
202 return $this->setOptionLegacy( 'allowExternalImages', $x );
206 * External images to allow
208 * When self::getAllowExternalImages() is false
210 * @return string|string[] URLs to allow
212 public function getAllowExternalImagesFrom() {
213 return $this->getOption( 'allowExternalImagesFrom' );
217 * External images to allow
219 * When self::getAllowExternalImages() is false
221 * @param string|string[]|null $x New value (null is no change)
222 * @return string|string[] Old value
224 public function setAllowExternalImagesFrom( $x ) {
225 return $this->setOptionLegacy( 'allowExternalImagesFrom', $x );
229 * Use the on-wiki external image whitelist?
232 public function getEnableImageWhitelist() {
233 return $this->getOption( 'enableImageWhitelist' );
237 * Use the on-wiki external image whitelist?
238 * @param bool|null $x New value (null is no change)
239 * @return bool Old value
241 public function setEnableImageWhitelist( $x ) {
242 return $this->setOptionLegacy( 'enableImageWhitelist', $x );
246 * Automatically number headings?
249 public function getNumberHeadings() {
250 return $this->getOption( 'numberheadings' );
254 * Automatically number headings?
255 * @param bool|null $x New value (null is no change)
256 * @return bool Old value
258 public function setNumberHeadings( $x ) {
259 return $this->setOptionLegacy( 'numberheadings', $x );
263 * Allow inclusion of special pages?
266 public function getAllowSpecialInclusion() {
267 return $this->getOption( 'allowSpecialInclusion' );
271 * Allow inclusion of special pages?
272 * @param bool|null $x New value (null is no change)
273 * @return bool Old value
275 public function setAllowSpecialInclusion( $x ) {
276 return $this->setOptionLegacy( 'allowSpecialInclusion', $x );
280 * Use tidy to cleanup output HTML?
283 public function getTidy() {
284 return $this->getOption( 'tidy' );
288 * Use tidy to cleanup output HTML?
289 * @param bool|null $x New value (null is no change)
290 * @return bool Old value
292 public function setTidy( $x ) {
293 return $this->setOptionLegacy( 'tidy', $x );
297 * Parsing an interface message?
300 public function getInterfaceMessage() {
301 return $this->getOption( 'interfaceMessage' );
305 * Parsing an interface message?
306 * @param bool|null $x New value (null is no change)
307 * @return bool Old value
309 public function setInterfaceMessage( $x ) {
310 return $this->setOptionLegacy( 'interfaceMessage', $x );
314 * Target language for the parse
315 * @return Language|null
317 public function getTargetLanguage() {
318 return $this->getOption( 'targetLanguage' );
322 * Target language for the parse
323 * @param Language|null $x New value
324 * @return Language|null Old value
326 public function setTargetLanguage( $x ) {
327 return $this->setOption( 'targetLanguage', $x );
331 * Maximum size of template expansions, in bytes
334 public function getMaxIncludeSize() {
335 return $this->getOption( 'maxIncludeSize' );
339 * Maximum size of template expansions, in bytes
340 * @param int|null $x New value (null is no change)
341 * @return int Old value
343 public function setMaxIncludeSize( $x ) {
344 return $this->setOptionLegacy( 'maxIncludeSize', $x );
348 * Maximum number of nodes touched by PPFrame::expand()
351 public function getMaxPPNodeCount() {
352 return $this->getOption( 'maxPPNodeCount' );
356 * Maximum number of nodes touched by PPFrame::expand()
357 * @param int|null $x New value (null is no change)
358 * @return int Old value
360 public function setMaxPPNodeCount( $x ) {
361 return $this->setOptionLegacy( 'maxPPNodeCount', $x );
365 * Maximum number of nodes generated by Preprocessor::preprocessToObj()
368 public function getMaxGeneratedPPNodeCount() {
369 return $this->getOption( 'maxGeneratedPPNodeCount' );
373 * Maximum number of nodes generated by Preprocessor::preprocessToObj()
374 * @param int|null $x New value (null is no change)
377 public function setMaxGeneratedPPNodeCount( $x ) {
378 return $this->setOptionLegacy( 'maxGeneratedPPNodeCount', $x );
382 * Maximum recursion depth in PPFrame::expand()
385 public function getMaxPPExpandDepth() {
386 return $this->getOption( 'maxPPExpandDepth' );
390 * Maximum recursion depth for templates within templates
393 public function getMaxTemplateDepth() {
394 return $this->getOption( 'maxTemplateDepth' );
398 * Maximum recursion depth for templates within templates
399 * @param int|null $x New value (null is no change)
400 * @return int Old value
402 public function setMaxTemplateDepth( $x ) {
403 return $this->setOptionLegacy( 'maxTemplateDepth', $x );
407 * Maximum number of calls per parse to expensive parser functions
411 public function getExpensiveParserFunctionLimit() {
412 return $this->getOption( 'expensiveParserFunctionLimit' );
416 * Maximum number of calls per parse to expensive parser functions
418 * @param int|null $x New value (null is no change)
419 * @return int Old value
421 public function setExpensiveParserFunctionLimit( $x ) {
422 return $this->setOptionLegacy( 'expensiveParserFunctionLimit', $x );
426 * Remove HTML comments
427 * @warning Only applies to preprocess operations
430 public function getRemoveComments() {
431 return $this->getOption( 'removeComments' );
435 * Remove HTML comments
436 * @warning Only applies to preprocess operations
437 * @param bool|null $x New value (null is no change)
438 * @return bool Old value
440 public function setRemoveComments( $x ) {
441 return $this->setOptionLegacy( 'removeComments', $x );
445 * Enable limit report in an HTML comment on output
448 public function getEnableLimitReport() {
449 return $this->getOption( 'enableLimitReport' );
453 * Enable limit report in an HTML comment on output
454 * @param bool|null $x New value (null is no change)
455 * @return bool Old value
457 public function enableLimitReport( $x = true ) {
458 return $this->setOptionLegacy( 'enableLimitReport', $x );
462 * Clean up signature texts?
463 * @see Parser::cleanSig
466 public function getCleanSignatures() {
467 return $this->getOption( 'cleanSignatures' );
471 * Clean up signature texts?
472 * @see Parser::cleanSig
473 * @param bool|null $x New value (null is no change)
474 * @return bool Old value
476 public function setCleanSignatures( $x ) {
477 return $this->setOptionLegacy( 'cleanSignatures', $x );
481 * Target attribute for external links
484 public function getExternalLinkTarget() {
485 return $this->getOption( 'externalLinkTarget' );
489 * Target attribute for external links
490 * @param string|null $x New value (null is no change)
491 * @return string Old value
493 public function setExternalLinkTarget( $x ) {
494 return $this->setOptionLegacy( 'externalLinkTarget', $x );
498 * Whether content conversion should be disabled
501 public function getDisableContentConversion() {
502 return $this->getOption( 'disableContentConversion' );
506 * Whether content conversion should be disabled
507 * @param bool|null $x New value (null is no change)
508 * @return bool Old value
510 public function disableContentConversion( $x = true ) {
511 return $this->setOptionLegacy( 'disableContentConversion', $x );
515 * Whether title conversion should be disabled
518 public function getDisableTitleConversion() {
519 return $this->getOption( 'disableTitleConversion' );
523 * Whether title conversion should be disabled
524 * @param bool|null $x New value (null is no change)
525 * @return bool Old value
527 public function disableTitleConversion( $x = true ) {
528 return $this->setOptionLegacy( 'disableTitleConversion', $x );
532 * Thumb size preferred by the user.
535 public function getThumbSize() {
536 return $this->getOption( 'thumbsize' );
540 * Thumb size preferred by the user.
541 * @param int|null $x New value (null is no change)
542 * @return int Old value
544 public function setThumbSize( $x ) {
545 return $this->setOptionLegacy( 'thumbsize', $x );
549 * Thumb size preferred by the user.
552 public function getStubThreshold() {
553 return $this->getOption( 'stubthreshold' );
557 * Thumb size preferred by the user.
558 * @param int|null $x New value (null is no change)
559 * @return int Old value
561 public function setStubThreshold( $x ) {
562 return $this->setOptionLegacy( 'stubthreshold', $x );
566 * Parsing the page for a "preview" operation?
569 public function getIsPreview() {
570 return $this->getOption( 'isPreview' );
574 * Parsing the page for a "preview" operation?
575 * @param bool|null $x New value (null is no change)
576 * @return bool Old value
578 public function setIsPreview( $x ) {
579 return $this->setOptionLegacy( 'isPreview', $x );
583 * Parsing the page for a "preview" operation on a single section?
586 public function getIsSectionPreview() {
587 return $this->getOption( 'isSectionPreview' );
591 * Parsing the page for a "preview" operation on a single section?
592 * @param bool|null $x New value (null is no change)
593 * @return bool Old value
595 public function setIsSectionPreview( $x ) {
596 return $this->setOptionLegacy( 'isSectionPreview', $x );
600 * Parsing the printable version of the page?
603 public function getIsPrintable() {
604 return $this->getOption( 'printable' );
608 * Parsing the printable version of the page?
609 * @param bool|null $x New value (null is no change)
610 * @return bool Old value
612 public function setIsPrintable( $x ) {
613 return $this->setOptionLegacy( 'printable', $x );
617 * Transform wiki markup when saving the page?
620 public function getPreSaveTransform() {
621 return $this->getOption( 'preSaveTransform' );
625 * Transform wiki markup when saving the page?
626 * @param bool|null $x New value (null is no change)
627 * @return bool Old value
629 public function setPreSaveTransform( $x ) {
630 return $this->setOptionLegacy( 'preSaveTransform', $x );
637 public function getDateFormat() {
638 return $this->getOption( 'dateformat' );
642 * Lazy initializer for dateFormat
644 private static function initDateFormat( $popt ) {
645 return $popt->mUser
->getDatePreference();
650 * @param string|null $x New value (null is no change)
651 * @return string Old value
653 public function setDateFormat( $x ) {
654 return $this->setOptionLegacy( 'dateformat', $x );
658 * Get the user language used by the parser for this page and split the parser cache.
660 * @warning: Calling this causes the parser cache to be fragmented by user language!
661 * To avoid cache fragmentation, output should not depend on the user language.
662 * Use Parser::getFunctionLang() or Parser::getTargetLanguage() instead!
664 * @note This function will trigger a cache fragmentation by recording the
665 * 'userlang' option, see optionUsed(). This is done to avoid cache pollution
666 * when the page is rendered based on the language of the user.
668 * @note When saving, this will return the default language instead of the user's.
669 * {{int: }} uses this which used to produce inconsistent link tables (T16404).
674 public function getUserLangObj() {
675 return $this->getOption( 'userlang' );
679 * Same as getUserLangObj() but returns a string instead.
681 * @warning: Calling this causes the parser cache to be fragmented by user language!
682 * To avoid cache fragmentation, output should not depend on the user language.
683 * Use Parser::getFunctionLang() or Parser::getTargetLanguage() instead!
685 * @see getUserLangObj()
687 * @return string Language code
690 public function getUserLang() {
691 return $this->getUserLangObj()->getCode();
695 * Set the user language used by the parser for this page and split the parser cache.
696 * @param string|Language $x New value
697 * @return Language Old value
699 public function setUserLang( $x ) {
700 if ( is_string( $x ) ) {
701 $x = Language
::factory( $x );
704 return $this->setOptionLegacy( 'userlang', $x );
708 * Are magic ISBN links enabled?
712 public function getMagicISBNLinks() {
713 return $this->getOption( 'magicISBNLinks' );
717 * Are magic PMID links enabled?
721 public function getMagicPMIDLinks() {
722 return $this->getOption( 'magicPMIDLinks' );
725 * Are magic RFC links enabled?
729 public function getMagicRFCLinks() {
730 return $this->getOption( 'magicRFCLinks' );
734 * If the wiki is configured to allow raw html ($wgRawHtml = true)
735 * is it allowed in the specific case of parsing this page.
737 * This is meant to disable unsafe parser tags in cases where
738 * a malicious user may control the input to the parser.
740 * @note This is expected to be true for normal pages even if the
741 * wiki has $wgRawHtml disabled in general. The setting only
742 * signifies that raw html would be unsafe in the current context
743 * provided that raw html is allowed at all.
747 public function getAllowUnsafeRawHtml() {
748 return $this->getOption( 'allowUnsafeRawHtml' );
752 * If the wiki is configured to allow raw html ($wgRawHtml = true)
753 * is it allowed in the specific case of parsing this page.
754 * @see self::getAllowUnsafeRawHtml()
756 * @param bool|null $x Value to set or null to get current value
757 * @return bool Current value for allowUnsafeRawHtml
759 public function setAllowUnsafeRawHtml( $x ) {
760 return $this->setOptionLegacy( 'allowUnsafeRawHtml', $x );
764 * Class to use to wrap output from Parser::parse()
766 * @return string|bool
768 public function getWrapOutputClass() {
769 return $this->getOption( 'wrapclass' );
773 * CSS class to use to wrap output from Parser::parse()
775 * @param string $className Class name to use for wrapping.
776 * Passing false to indicate "no wrapping" was deprecated in MediaWiki 1.31.
777 * @return string|bool Current value
779 public function setWrapOutputClass( $className ) {
780 if ( $className === true ) { // DWIM, they probably want the default class name
781 $className = 'mw-parser-output';
783 if ( $className === false ) {
784 wfDeprecated( __METHOD__
. '( false )', '1.31' );
786 return $this->setOption( 'wrapclass', $className );
790 * Callback for current revision fetching; first argument to call_user_func().
794 public function getCurrentRevisionCallback() {
795 return $this->getOption( 'currentRevisionCallback' );
799 * Callback for current revision fetching; first argument to call_user_func().
801 * @param callable|null $x New value (null is no change)
802 * @return callable Old value
804 public function setCurrentRevisionCallback( $x ) {
805 return $this->setOptionLegacy( 'currentRevisionCallback', $x );
809 * Callback for template fetching; first argument to call_user_func().
812 public function getTemplateCallback() {
813 return $this->getOption( 'templateCallback' );
817 * Callback for template fetching; first argument to call_user_func().
818 * @param callable|null $x New value (null is no change)
819 * @return callable Old value
821 public function setTemplateCallback( $x ) {
822 return $this->setOptionLegacy( 'templateCallback', $x );
826 * Callback to generate a guess for {{REVISIONID}}
828 * @return callable|null
830 public function getSpeculativeRevIdCallback() {
831 return $this->getOption( 'speculativeRevIdCallback' );
835 * Callback to generate a guess for {{REVISIONID}}
837 * @param callable|null $x New value (null is no change)
838 * @return callable|null Old value
840 public function setSpeculativeRevIdCallback( $x ) {
841 return $this->setOptionLegacy( 'speculativeRevIdCallback', $x );
847 * Timestamp used for {{CURRENTDAY}} etc.
850 public function getTimestamp() {
851 if ( !isset( $this->mTimestamp
) ) {
852 $this->mTimestamp
= wfTimestampNow();
854 return $this->mTimestamp
;
858 * Timestamp used for {{CURRENTDAY}} etc.
859 * @param string|null $x New value (null is no change)
860 * @return string Old value
862 public function setTimestamp( $x ) {
863 return wfSetVar( $this->mTimestamp
, $x );
867 * Create "edit section" links?
868 * @deprecated since 1.31, use ParserOutput::getText() options instead.
871 public function getEditSection() {
872 wfDeprecated( __METHOD__
, '1.31' );
877 * Create "edit section" links?
878 * @deprecated since 1.31, use ParserOutput::getText() options instead.
879 * @param bool|null $x New value (null is no change)
880 * @return bool Old value
882 public function setEditSection( $x ) {
883 wfDeprecated( __METHOD__
, '1.31' );
888 * Set the redirect target.
890 * Note that setting or changing this does not *make* the page a redirect
891 * or change its target, it merely records the information for reference
895 * @param Title|null $title
897 function setRedirectTarget( $title ) {
898 $this->redirectTarget
= $title;
902 * Get the previously-set redirect target.
907 function getRedirectTarget() {
908 return $this->redirectTarget
;
912 * Extra key that should be present in the parser cache key.
913 * @warning Consider registering your additional options with the
914 * ParserOptionsRegister hook instead of using this method.
917 public function addExtraKey( $key ) {
918 $this->mExtraKey
.= '!' . $key;
925 public function getUser() {
930 * @warning For interaction with the parser cache, use
931 * WikiPage::makeParserOptions(), ContentHandler::makeParserOptions(), or
932 * ParserOptions::newCanonical() instead.
934 * @param Language $lang
936 public function __construct( $user = null, $lang = null ) {
937 if ( $user === null ) {
939 if ( $wgUser === null ) {
945 if ( $lang === null ) {
947 if ( !StubObject
::isRealObject( $wgLang ) ) {
952 $this->initialiseFromUser( $user, $lang );
956 * Get a ParserOptions object for an anonymous user
957 * @warning For interaction with the parser cache, use
958 * WikiPage::makeParserOptions(), ContentHandler::makeParserOptions(), or
959 * ParserOptions::newCanonical() instead.
961 * @return ParserOptions
963 public static function newFromAnon() {
965 return new ParserOptions( new User
, $wgContLang );
969 * Get a ParserOptions object from a given user.
970 * Language will be taken from $wgLang.
972 * @warning For interaction with the parser cache, use
973 * WikiPage::makeParserOptions(), ContentHandler::makeParserOptions(), or
974 * ParserOptions::newCanonical() instead.
976 * @return ParserOptions
978 public static function newFromUser( $user ) {
979 return new ParserOptions( $user );
983 * Get a ParserOptions object from a given user and language
985 * @warning For interaction with the parser cache, use
986 * WikiPage::makeParserOptions(), ContentHandler::makeParserOptions(), or
987 * ParserOptions::newCanonical() instead.
989 * @param Language $lang
990 * @return ParserOptions
992 public static function newFromUserAndLang( User
$user, Language
$lang ) {
993 return new ParserOptions( $user, $lang );
997 * Get a ParserOptions object from a IContextSource object
999 * @warning For interaction with the parser cache, use
1000 * WikiPage::makeParserOptions(), ContentHandler::makeParserOptions(), or
1001 * ParserOptions::newCanonical() instead.
1002 * @param IContextSource $context
1003 * @return ParserOptions
1005 public static function newFromContext( IContextSource
$context ) {
1006 return new ParserOptions( $context->getUser(), $context->getLanguage() );
1010 * Creates a "canonical" ParserOptions object
1012 * For historical reasons, certain options have default values that are
1013 * different from the canonical values used for caching.
1016 * @param User|null $user
1017 * @param Language|StubObject|null $lang
1018 * @return ParserOptions
1020 public static function newCanonical( User
$user = null, $lang = null ) {
1021 $ret = new ParserOptions( $user, $lang );
1022 foreach ( self
::getCanonicalOverrides() as $k => $v ) {
1023 $ret->setOption( $k, $v );
1029 * Get default option values
1030 * @warning If you change the default for an existing option (unless it's
1031 * being overridden by self::getCanonicalOverrides()), all existing parser
1032 * cache entries will be invalid. To avoid bugs, you'll need to handle
1033 * that somehow (e.g. with the RejectParserCacheValue hook) because
1034 * MediaWiki won't do it for you.
1037 private static function getDefaults() {
1038 global $wgInterwikiMagic, $wgAllowExternalImages,
1039 $wgAllowExternalImagesFrom, $wgEnableImageWhitelist, $wgAllowSpecialInclusion,
1040 $wgMaxArticleSize, $wgMaxPPNodeCount, $wgMaxTemplateDepth, $wgMaxPPExpandDepth,
1041 $wgCleanSignatures, $wgExternalLinkTarget, $wgExpensiveParserFunctionLimit,
1042 $wgMaxGeneratedPPNodeCount, $wgDisableLangConversion, $wgDisableTitleConversion,
1043 $wgEnableMagicLinks, $wgContLang;
1045 if ( self
::$defaults === null ) {
1046 // *UPDATE* ParserOptions::matches() if any of this changes as needed
1048 'dateformat' => null,
1050 'interfaceMessage' => false,
1051 'targetLanguage' => null,
1052 'removeComments' => true,
1053 'enableLimitReport' => false,
1054 'preSaveTransform' => true,
1055 'isPreview' => false,
1056 'isSectionPreview' => false,
1057 'printable' => false,
1058 'allowUnsafeRawHtml' => true,
1059 'wrapclass' => 'mw-parser-output',
1060 'currentRevisionCallback' => [ Parser
::class, 'statelessFetchRevision' ],
1061 'templateCallback' => [ Parser
::class, 'statelessFetchTemplate' ],
1062 'speculativeRevIdCallback' => null,
1065 Hooks
::run( 'ParserOptionsRegister', [
1068 &self
::$lazyOptions,
1071 ksort( self
::$inCacheKey );
1074 // Unit tests depend on being able to modify the globals at will
1075 return self
::$defaults +
[
1076 'interwikiMagic' => $wgInterwikiMagic,
1077 'allowExternalImages' => $wgAllowExternalImages,
1078 'allowExternalImagesFrom' => $wgAllowExternalImagesFrom,
1079 'enableImageWhitelist' => $wgEnableImageWhitelist,
1080 'allowSpecialInclusion' => $wgAllowSpecialInclusion,
1081 'maxIncludeSize' => $wgMaxArticleSize * 1024,
1082 'maxPPNodeCount' => $wgMaxPPNodeCount,
1083 'maxGeneratedPPNodeCount' => $wgMaxGeneratedPPNodeCount,
1084 'maxPPExpandDepth' => $wgMaxPPExpandDepth,
1085 'maxTemplateDepth' => $wgMaxTemplateDepth,
1086 'expensiveParserFunctionLimit' => $wgExpensiveParserFunctionLimit,
1087 'externalLinkTarget' => $wgExternalLinkTarget,
1088 'cleanSignatures' => $wgCleanSignatures,
1089 'disableContentConversion' => $wgDisableLangConversion,
1090 'disableTitleConversion' => $wgDisableLangConversion ||
$wgDisableTitleConversion,
1091 'magicISBNLinks' => $wgEnableMagicLinks['ISBN'],
1092 'magicPMIDLinks' => $wgEnableMagicLinks['PMID'],
1093 'magicRFCLinks' => $wgEnableMagicLinks['RFC'],
1094 'numberheadings' => User
::getDefaultOption( 'numberheadings' ),
1095 'thumbsize' => User
::getDefaultOption( 'thumbsize' ),
1096 'stubthreshold' => 0,
1097 'userlang' => $wgContLang,
1102 * Get "canonical" non-default option values
1103 * @see self::newCanonical
1104 * @warning If you change the override for an existing option, all existing
1105 * parser cache entries will be invalid. To avoid bugs, you'll need to
1106 * handle that somehow (e.g. with the RejectParserCacheValue hook) because
1107 * MediaWiki won't do it for you.
1110 private static function getCanonicalOverrides() {
1111 global $wgEnableParserLimitReporting;
1115 'enableLimitReport' => $wgEnableParserLimitReporting,
1123 * @param Language $lang
1125 private function initialiseFromUser( $user, $lang ) {
1126 $this->options
= self
::getDefaults();
1128 $this->mUser
= $user;
1129 $this->options
['numberheadings'] = $user->getOption( 'numberheadings' );
1130 $this->options
['thumbsize'] = $user->getOption( 'thumbsize' );
1131 $this->options
['stubthreshold'] = $user->getStubThreshold();
1132 $this->options
['userlang'] = $lang;
1136 * Check if these options match that of another options set
1138 * This ignores report limit settings that only affect HTML comments
1140 * @param ParserOptions $other
1144 public function matches( ParserOptions
$other ) {
1145 // Populate lazy options
1146 foreach ( self
::$lazyOptions as $name => $callback ) {
1147 if ( $this->options
[$name] === null ) {
1148 $this->options
[$name] = call_user_func( $callback, $this, $name );
1150 if ( $other->options
[$name] === null ) {
1151 $other->options
[$name] = call_user_func( $callback, $other, $name );
1155 // Compare most options
1156 $options = array_keys( $this->options
);
1157 $options = array_diff( $options, [
1158 'enableLimitReport', // only affects HTML comments
1160 foreach ( $options as $option ) {
1161 $o1 = $this->optionToString( $this->options
[$option] );
1162 $o2 = $this->optionToString( $other->options
[$option] );
1163 if ( $o1 !== $o2 ) {
1168 // Compare most other fields
1169 $fields = array_keys( get_class_vars( __CLASS__
) );
1170 $fields = array_diff( $fields, [
1171 'defaults', // static
1172 'lazyOptions', // static
1173 'inCacheKey', // static
1174 'options', // Already checked above
1175 'onAccessCallback', // only used for ParserOutput option tracking
1177 foreach ( $fields as $field ) {
1178 if ( !is_object( $this->$field ) && $this->$field !== $other->$field ) {
1187 * Registers a callback for tracking which ParserOptions which are used.
1188 * This is a private API with the parser.
1189 * @param callable $callback
1191 public function registerWatcher( $callback ) {
1192 $this->onAccessCallback
= $callback;
1196 * Called when an option is accessed.
1197 * Calls the watcher that was set using registerWatcher().
1198 * Typically, the watcher callback is ParserOutput::registerOption().
1199 * The information registered that way will be used by ParserCache::save().
1201 * @param string $optionName Name of the option
1203 public function optionUsed( $optionName ) {
1204 if ( $this->onAccessCallback
) {
1205 call_user_func( $this->onAccessCallback
, $optionName );
1210 * Returns the full array of options that would have been used by
1212 * Used to get the old parser cache entries when available.
1213 * @deprecated since 1.30. You probably want self::allCacheVaryingOptions() instead.
1216 public static function legacyOptions() {
1217 wfDeprecated( __METHOD__
, '1.30' );
1229 * Return all option keys that vary the options hash
1233 public static function allCacheVaryingOptions() {
1234 // Trigger a call to the 'ParserOptionsRegister' hook if it hasn't
1235 // already been called.
1236 if ( self
::$defaults === null ) {
1237 self
::getDefaults();
1239 return array_keys( array_filter( self
::$inCacheKey ) );
1243 * Convert an option to a string value
1244 * @param mixed $value
1247 private function optionToString( $value ) {
1248 if ( $value === true ) {
1250 } elseif ( $value === false ) {
1252 } elseif ( $value === null ) {
1254 } elseif ( $value instanceof Language
) {
1255 return $value->getCode();
1256 } elseif ( is_array( $value ) ) {
1257 return '[' . implode( ',', array_map( [ $this, 'optionToString' ], $value ) ) . ']';
1259 return (string)$value;
1264 * Generate a hash string with the values set on these ParserOptions
1265 * for the keys given in the array.
1266 * This will be used as part of the hash key for the parser cache,
1267 * so users sharing the options with vary for the same page share
1268 * the same cached data safely.
1271 * @param string[] $forOptions
1272 * @param Title $title Used to get the content language of the page (since r97636)
1273 * @return string Page rendering hash
1275 public function optionsHash( $forOptions, $title = null ) {
1276 global $wgRenderHashAppend;
1278 $inCacheKey = self
::allCacheVaryingOptions();
1280 // Resolve any lazy options
1281 foreach ( array_intersect( $forOptions, $inCacheKey, array_keys( self
::$lazyOptions ) ) as $k ) {
1282 if ( $this->options
[$k] === null ) {
1283 $this->options
[$k] = call_user_func( self
::$lazyOptions[$k], $this, $k );
1287 $options = $this->options
;
1288 $defaults = self
::getCanonicalOverrides() + self
::getDefaults();
1290 // We only include used options with non-canonical values in the key
1291 // so adding a new option doesn't invalidate the entire parser cache.
1292 // The drawback to this is that changing the default value of an option
1293 // requires manual invalidation of existing cache entries, as mentioned
1294 // in the docs on the relevant methods and hooks.
1296 foreach ( array_intersect( $inCacheKey, $forOptions ) as $option ) {
1297 $v = $this->optionToString( $options[$option] );
1298 $d = $this->optionToString( $defaults[$option] );
1300 $values[] = "$option=$v";
1304 $confstr = $values ?
implode( '!', $values ) : 'canonical';
1306 // add in language specific options, if any
1307 // @todo FIXME: This is just a way of retrieving the url/user preferred variant
1308 if ( !is_null( $title ) ) {
1309 $confstr .= $title->getPageLanguage()->getExtraHashOptions();
1312 $confstr .= $wgContLang->getExtraHashOptions();
1315 $confstr .= $wgRenderHashAppend;
1317 if ( $this->mExtraKey
!= '' ) {
1318 $confstr .= $this->mExtraKey
;
1321 // Give a chance for extensions to modify the hash, if they have
1322 // extra options or other effects on the parser cache.
1323 Hooks
::run( 'PageRenderingHash', [ &$confstr, $this->getUser(), &$forOptions ] );
1325 // Make it a valid memcached key fragment
1326 $confstr = str_replace( ' ', '_', $confstr );
1332 * Test whether these options are safe to cache
1336 public function isSafeToCache() {
1337 $defaults = self
::getCanonicalOverrides() + self
::getDefaults();
1338 foreach ( $this->options
as $option => $value ) {
1339 if ( empty( self
::$inCacheKey[$option] ) ) {
1340 $v = $this->optionToString( $value );
1341 $d = $this->optionToString( $defaults[$option] );
1351 * Sets a hook to force that a page exists, and sets a current revision callback to return
1352 * a revision with custom content when the current revision of the page is requested.
1355 * @param Title $title
1356 * @param Content $content
1357 * @param User $user The user that the fake revision is attributed to
1358 * @return ScopedCallback to unset the hook
1360 public function setupFakeRevision( $title, $content, $user ) {
1361 $oldCallback = $this->setCurrentRevisionCallback(
1363 $titleToCheck, $parser = false ) use ( $title, $content, $user, &$oldCallback
1365 if ( $titleToCheck->equals( $title ) ) {
1366 return new Revision( [
1367 'page' => $title->getArticleID(),
1368 'user_text' => $user->getName(),
1369 'user' => $user->getId(),
1370 'parent_id' => $title->getLatestRevID(),
1372 'content' => $content
1375 return call_user_func( $oldCallback, $titleToCheck, $parser );
1381 $wgHooks['TitleExists'][] =
1382 function ( $titleToCheck, &$exists ) use ( $title ) {
1383 if ( $titleToCheck->equals( $title ) ) {
1387 end( $wgHooks['TitleExists'] );
1388 $key = key( $wgHooks['TitleExists'] );
1389 LinkCache
::singleton()->clearBadLink( $title->getPrefixedDBkey() );
1390 return new ScopedCallback( function () use ( $title, $key ) {
1392 unset( $wgHooks['TitleExists'][$key] );
1393 LinkCache
::singleton()->clearLink( $title );
1399 * For really cool vim folding this needs to be at the end:
1400 * vim: foldmarker=@{,@} foldmethod=marker